<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.1 and later</td></tr></table>
<h3>Summary</h3>
<p>This module implements a generic locking API which can be used by any
backend provider of <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code>. It <em>requires</em> at least
the service of <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code>. But without a backend provider
which makes use of it, it's useless and should not be loaded into the
server. A sample backend module which actually utilizes
<code class="module"><a href="../mod/mod_dav_lock.html">mod_dav_lock</a></code>, is <a href="http://subversion.tigris.org/">mod_dav_svn</a>, the subversion provider module.</p>
<p>Note that <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> does <em>not</em> need this
generic locking module, because it uses it's own more specialized
version.</p>
<p>In order to make <code class="module"><a href="../mod/mod_dav_lock.html">mod_dav_lock</a></code> functional, you just have
to specify the location of the lock database using the <code class="directive"><a href="#davgenericlockdb">DavGenericLockDB</a></code> directive described
below.</p>
<div class="note"><h3>Developer's Note</h3>
<p>In order to retrieve the pointer to the locking provider function, you
have to use the <code>ap_lookup_provider</code> API with the arguments
<code>dav-lock</code>, <code>generic</code> and <code>0</code>.</p>
<p>Use the <code class="directive">DavGenericLockDB</code> directive to specify
the full path to the lock database, excluding an extension. If
the path is not absolute, it will be taken relative to <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. The implementation of
<code class="module"><a href="../mod/mod_dav_lock.html">mod_dav_lock</a></code> uses a SDBM database to track user
locks.</p>
<div class="example"><h3>Example</h3><p><code>
DavGenericLockDB var/DavLock
</code></p></div>
<p>The directory containing the lock database file must be
writable by the <code class="directive"><a href="../mod/mpm_common.html#user">User</a></code>
and <code class="directive"><a href="../mod/mpm_common.html#group">Group</a></code> under which
Apache is running. For security reasons, you should create a
directory for this purpose rather than changing the permissions on
an existing directory. In the above example, Apache will create
files in the <code>var/</code> directory under the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code> with the base filename
<code>DavLock</code> and extension name chosen by the server.</p>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="../en/mod/mod_dav_lock.html" title="English"> en </a> |
<a href="../ja/mod/mod_dav_lock.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
</div><div id="footer">
<p class="apache">Copyright 1995-2006 The Apache Software Foundation or its licensors, as applicable.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>